/*
 * Copyright (c) 2008 VMware, Inc.
 * Copyright (c) 2009 John Pritchard, WTKX Project Group
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package wtkx;

import java.awt.Graphics2D;
import java.awt.geom.AffineTransform;
import java.awt.geom.Rectangle2D;

/**
 * Interface defining a component "effect". Effects allow a caller to
 * attach additional visual effects to a component.
 *
 * @author gbrown
 * @author jdp
 */
public interface Effect {

    /**
     * A modal effect uses {@link wtkx.in.RepaintJump$Animating
     * Animator Repaints} when it runs.
     * 
     * @author jdp
     */
    public interface Modal
        extends Effect.Runs
    {}
    /**
     * This effect runs to show a component.
     * 
     * @author jdp
     */
    public interface OnShow
        extends Runs
    {
        public void effectShow(Component component);
    }
    /**
     * This effect runs to hide a component.
     * 
     * @author jdp
     */
    public interface OnHide
        extends Runs
    {
        public void effectHide(Component component);
    }
    /**
     * A temporary effect.
     * 
     * @author jdp
     */
    public interface Runs 
        extends Effect
    {

        public boolean isRunning();
    }

    public void layout(Component component);

    public void destroy();

    /**
     * 
     *
     * @param component
     * @param g Effecting graphics context
     *
     * @return
     * The graphics context that should be used by the component
     */
    public Graphics2D prepare(Component component, Graphics2D g);

    /**
     * 
     * 
     * @param g Parent graphics context, often ignored.
     */
    public void update(Graphics2D g);

    public Rectangle2D.Float getBounds(Component component);

    /**
     * @return Non null to transform the component's dimensions
     */
    public AffineTransform getTransform(Component component);

}
